Installing RT Client API Using Silent Installation
Real-Time Client API is provided with Advanced Process Automation 4.9.6 and higher, and is installed automatically during the Real-Time Client installation.
To install the Real-Time Client see the Advanced Process Automation Client and Designer Installation Guide.
Enabling the Real-Time Client API, opens a port on the Real-Time Client machine.
To install Real-Time Client API:
| 1. | Install Real-Time Client 4.9.6 or higher using the Silent (Unattended) parameters. |
For the complete Silent installation parameters, see the Advanced Process Automation Client and Designer Installation Guide.
| 2. | To activate the Real-Time Client API, on the Real-Time Client machine, perform a silent installation using the following parameters: |
|
Property |
Set Value As... |
Default value |
Description |
Used In |
|
SOAPListenerEnabled |
True |
False |
Enable or disable the Real-Time Client API. |
Designer Client |
|
SOAPListenerPort |
Enter a value between 1024 - 65535 |
8080 |
Real-Time Client API port number. |
Designer Client |
| 3. | If you have a Shared Resources Environment, you must also define the following parameters: |
| Property | Set Value As.. | Default Value | Description |
|---|---|---|---|
|
SOAPLISTENERWEBENABLED |
True |
False |
Set this to True to enable web access to the Real-Time Client API. |
|
SOAPLISTENERWEBPORT |
Enter the port number to the Real-Time Client API web access. |
8081 |
|
|
SOAPListenerUseSharedResourcesMode |
True |
False |
Set this to True when using a shared resources environment. |
|
SOAPListenerMaxlPort |
Enter the highest port number in the available port range. |
41414 |
The highest port number in the available range. |
|
SOAPListenerMinPort |
Enter the lowest port number in the available port range. |
41414 | The lowest port number in the available range. |
|
SOAPListenerResolutionMethod |
One of the following: WindowsUsernameOnly WindowsUsernameWithDomain WindowsUsernameWithFQDN MachineNameWithSessionId |
WindowsUsernameOnly |
Define the unique identifier to be used. WindowsUsernameOnly Example: johns WindowsUsernameWithDomain Example: nice_systems\johns WindowsUsernameWithFQDN Example: nice.com\johns MachineNameWithSessionId Example: <machine_name>.<session_id> |
| 4. | Real-Time Client API is installed and activated. |
